home *** CD-ROM | disk | FTP | other *** search
/ X User Tools / X User Tools (O'Reilly and Associates)(1994).ISO / sun4c / archive / tcltk.z / tcltk / man / cat3 / GetRelief.3 < prev    next >
Text File  |  1994-09-20  |  3KB  |  133 lines
  1.  
  2.  
  3.  
  4. Tk_GetRelief(3)       Tk Library Procedures
  5.  
  6.  
  7.  
  8. _________________________________________________________________
  9.  
  10. NAME
  11.      Tk_GetRelief, Tk_NameOfRelief -  translate  between  strings
  12.      and relief values
  13.  
  14. SYNOPSIS
  15.      #include <tk.h>
  16.  
  17.      int
  18.      Tk_GetRelief(_i_n_t_e_r_p, _n_a_m_e, _r_e_l_i_e_f_P_t_r)
  19.  
  20.      char *
  21.      Tk_NameOfRelief(_r_e_l_i_e_f)
  22.  
  23. ARGUMENTS
  24.      Tcl_Interp   *_i_n_t_e_r_p      (in)      Interpreter to  use  for
  25.                                          error reporting.
  26.  
  27.      char         *_n_a_m_e        (in)      String containing relief
  28.                                          name  (one  of ``flat'',
  29.                                          ``groove'',  ``raised'',
  30.                                          ``ridge'',            or
  31.                                          ``sunken'').
  32.  
  33.      int          *_r_e_l_i_e_f_P_t_r   (out)     Pointer to  location  in
  34.                                          which  to  store  relief
  35.                                          value  corresponding  to
  36.                                          _n_a_m_e.
  37.  
  38.      int          _r_e_l_i_e_f       (in)      Relief  value  (one   of
  39.                                          TK_RELIEF_FLAT,
  40.                                          TK_RELIEF_RAISED,
  41.                                          TK_RELIEF_SUNKEN,  |
  42.                                          TK_RELIEF_GROOVE,     or  |
  43.                                          TK_RELIEF_RIDGE).
  44. _________________________________________________________________
  45.  
  46.  
  47. DESCRIPTION
  48.      Tk_GetRelief  places  in   *_r_e_l_i_e_f_P_t_r   the   relief   value
  49.      corresponding   to   _n_a_m_e.    This  value  will  be  one  of
  50.      TK_RELIEF_FLAT,     TK_RELIEF_RAISED,      TK_RELIEF_SUNKEN,  |
  51.      TK_RELIEF_GROOVE,  or  TK_RELIEF_RIDGE.   Under  normal cir-
  52.      cumstances the return value is TCL_OK and _i_n_t_e_r_p is  unused.
  53.      If  _n_a_m_e doesn't contain one of the valid relief names or an
  54.      abbreviation of one of them, then an error message is stored
  55.      in  _i_n_t_e_r_p->_r_e_s_u_l_t, TCL_ERROR is returned, and *_r_e_l_i_e_f_P_t_r is
  56.      unmodified.
  57.  
  58.      Tk_NameOfRelief is  the  logical  inverse  of  Tk_GetRelief.
  59.      Given  a  relief  value  it returns the corresponding string
  60.  
  61.  
  62.  
  63. Tk                                                              1
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. Tk_GetRelief(3)       Tk Library Procedures
  71.  
  72.  
  73.  
  74.      (``flat'',   ``raised'',    ``sunken'',    ``groove'',    or  |
  75.      ``ridge'').   If  _r_e_l_i_e_f  isn't  a  legal relief value, then
  76.      ``unknown relief'' is returned.
  77.  
  78.  
  79. KEYWORDS
  80.      name, relief, string
  81.  
  82.  
  83.  
  84.  
  85.  
  86.  
  87.  
  88.  
  89.  
  90.  
  91.  
  92.  
  93.  
  94.  
  95.  
  96.  
  97.  
  98.  
  99.  
  100.  
  101.  
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129. Tk                                                              2
  130.  
  131.  
  132.  
  133.